<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home In Manchester</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description_mc" content="">
<meta name="author" content="">

<!-- Le styles -->
<link href="assets/css/bootstrap.css" rel="stylesheet">
<link href="assets/css/bootstrap-responsive.css" rel="stylesheet">
<link href="assets/css/docs.css" rel="stylesheet">
<link href="assets/js/google-code-prettify/prettify.css"
	rel="stylesheet">

<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
      <script src="assets/js/html5shiv.js"></script>
    <![endif]-->

<style>
body {
	font-family: 微软雅黑;
	font-size: 14px;
}

.nav-list {
	margin-top: 0px;
}

h4 {
	margin-top: 25px;
}
</style>
</head>

<body data-spy="scroll" data-target=".bs-docs-sidebar">

	<!-- Navbar
    ================================================== -->
	<div class="navbar navbar-inverse navbar-fixed-top">
		<div class="navbar-inner">
			<div class="container">
				<button type="button" class="btn btn-navbar" data-toggle="collapse"
					data-target=".nav-collapse">
					<span class="icon-bar"></span> <span class="icon-bar"></span> <span
						class="icon-bar"></span>
				</button>
				<div class="nav-collapse collapse">
					<ul class="nav">
						<li class=""><a href="index.html">首页</a></li>
						<li class=""><a href="live.html">生活信息</a></li>
						<li class=""><a href="func.html">实用功能</a></li>
						<li class=""><a href="forum.html">娱乐交友</a></li>
						<li class=""><a href="study.html">学术讨论</a></li>
						<li class=""><a href="member.html">会员管理</a></li>
						<li class=""><a href="bookFood.html">订餐系统</a></li>
						<li class=""><a href="ticket.html">票务系统</a></li>
						<li class=""><a href="coupon.html">优惠券</a></li>
						<li class="active"><a href="readme.html">补充说明</a></li>
						<li class=""><a href="extend.html">扩展功能</a></li>
						<li class=""><a href="advert.html">广告</a></li>
						<li class=""><a href="report.html">公告系统</a></li>
						<li class=""><a href="radio.html">电台系统</a></li>
					</ul>
				</div>
			</div>
		</div>
	</div>

	<!-- Subhead
================================================== -->
	<header class="jumbotron subhead" id="overview">
		<div class="container">
			<h1>客户端接口调用指南</h1>
			<p class="lead">web客户端、移动客户端获取和设置服务器数据的统一接口访问规范。符合restful的api设计范式，提供跨平台的基于http协议的一致web接口。</p>
		</div>
	</header>


	<div class="container">

		<!-- Docs nav
    ================================================== -->
		<div class="row">
			<div class="span3 bs-docs-sidebar">
				<h3>客户端界面分类说明</h3>
				<ul class="nav nav-list bs-docs-sidenav">
					<li><a href="#restaurant"><i class="icon-chevron-right"></i>
							餐厅</a></li>
					<li><a href="#liveBang"><i class="icon-chevron-right"></i>
							生活信息大爆炸</a></li>
					<li><a href="#secondary"><i class="icon-chevron-right"></i>
							跳蚤市场</a></li>
					<li><a href="#rent"><i class="icon-chevron-right"></i>
							房屋租赁</a></li>
					<li><a href="#oneCity"><i class="icon-chevron-right"></i>
							同城</a></li>
					<li><a href="#group"><i class="icon-chevron-right"></i>
							学习小组</a></li>
					<li><a href="#ticket"><i class="icon-chevron-right"></i>
							票务</a></li>
					<li><a href="#together"><i class="icon-chevron-right"></i>
							约</a></li>
					<li><a href="#housekeeper"><i class="icon-chevron-right"></i>
							曼城小管家</a></li>
					<li><a href="#coupon"><i class="icon-chevron-right"></i>
							优惠券</a></li>
					<h3>意见反馈API</h3>
					<li><a href="#feedback"><i class="icon-chevron-right"></i>
							意见反馈</a></li>
				</ul>
				
				
			</div>
			<div class="span9">

				<!-- Typography
        ================================================== -->
				

				<!-- Code
        ================================================== -->
				<section id="restaurant">
					<div class="page-header">
						<h1>餐厅</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>1)、获取分类中所属餐厅部分的分类。这里的分类来自于生活信息栏目的信息分类，所属餐厅部分的分类唯一标示（sortId）为140。</p>
					<p>2)、关于餐厅下的分类排列顺序，可以根据sortNum由小到大依次排列，对应于如下图片的位置，为：</p>
					
					<p>
					<img src="assets/img/a1.jpg">
					</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>测试环境：<a href="http://115.29.250.136:8080/homeInManchester/api/live/sorts?parentId=140">http://115.29.250.136:8080/homeInManchester/api/live/sorts?parentId=140</a></p>
					<p>具体api说明请参考：<a href="live.html#sort">获取全部信息分类</a></p>


				</section>
				
				<section id="liveBang">
					<div class="page-header">
						<h1>生活信息大爆炸</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>此处信息来源还不明确，有待于需求明确后再确定。</p>
					


				</section>
				
				<section id="secondary">
					<div class="page-header">
						<h1>跳蚤市场</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>这里指的就是二手分类信息，具体内容可以完全参考实用功能栏目中二手交易部分的API。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>测试环境：<a href="http://115.29.250.136:8080/homeInManchester/api/secondary/sorts">http://115.29.250.136:8080/homeInManchester/api/secondary/sorts</a></p>
					<p>具体api说明请参考：<a href="func.html#secondary_sorts">获取二手信息分类</a></p>


				</section>
				<section id="rent">
					<div class="page-header">
						<h1>房屋租赁</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>获取实用功能栏目中房屋租赁部分的信息。这里的一级界面分类不知道是何种分类，是房屋类型还是出租类型等，有待于核实。目前系统中的房屋分类和出租分类都是固定死的内容，具体可以在实用功能栏目中查看。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/func/rents</p>
					<p>具体api说明请参考：<a href="func.html#rent_list">获取全部租房信息</a></p>


				</section>
				<section id="oneCity">
					<div class="page-header">
						<h1>同城</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>获取同城中的相关分类、信息。</p>
					<p>1）、一级界面中的分类为全国的省、直辖市、自治区。</p>
					<p>2）、默认为该省份的成员列表。可以申请加为好友。可以根据城市，进一步筛选某个城市的会员列表。</p>
					<p>3）、三级页面为该会员发表的论坛帖子以及相关回复。可以直接在此回复帖子。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/users/suggest/hometown/220500</p>
					<p>具体api说明请参考：<a href="member.html#getByHomeTown">获取同城会员列表</a></p>
					<p>关于加好友、回复论坛帖子等相关api，可以分别查看会员管理栏目和娱乐交友栏目。</p>

				</section>
				
				<section id="group">
					<div class="page-header">
						<h1>学习小组</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>1)、一级界面，可以获取院系分类。</p>
					<p>2)、二级界面，可以获取分类下的全部学习小组。</p>
					<p>3)、三级界面，可以获取学习小组下的帖子列表。</p>
					<p>4)、四级界面，可以获取学习小组下的帖子内容，并可以回复。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					
					<p>具体api说明请参考：<a href="study.html">学术讨论栏目 api</a></p>


				</section>
				
				<section id="ticket">
					<div class="page-header">
						<h1>票务</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>有关票务的信息可以查看票务栏目。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					
					<p>具体api说明请参考：<a href="ticket.html">票务系统 api</a></p>


				</section>
				
				<section id="together">
					<div class="page-header">
						<h1>约</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>”约“是来自于论坛的一个独立版块，ID标识固定。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					
					<p>具体api说明请参考：<a href="forum.html#forum1">"约"功能 api</a></p>


				</section>
				
				<section id="housekeeper">
					<div class="page-header">
						<h1>曼城小管家</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>该功能同餐厅分类，同样来自于生活信息栏目的信息分类。此处同样需要固定ID，这里默认为191。</p>
					
					<p>
					<img src="assets/img/a2.jpg">
					</p>
					<p>该分类下的子分类用序号区分（字段为sortNum）。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>测试环境：<a href="http://115.29.250.136:8080/homeInManchester/api/live/sorts?parentId=191">http://115.29.250.136:8080/homeInManchester/api/live/sorts?parentId=191</a></p>
					<p>具体api说明请参考：<a href="live.html#sort">获取全部信息分类</a></p>


				</section>
				
				<section id="coupon">
					<div class="page-header">
						<h1>优惠券</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>该功能正在开发中...预计在8月21号左右可以完成。</p>
					
					

				</section>
				
				<section id="feedback">
					<div class="page-header">
						<h1>意见反馈API</h1>
					</div>
					<h3>1 功能说明</h3>
					<p>客户可以将各种意见或建议反馈到系统后台。</p>
					
					<br></br>
					<h3>2 接口调用说明</h3>
					<h4>2.1 URL</h4>
					<p>正式环境：http://[域名]/api/feedback</p>
					<p>测试环境：http://115.29.250.136:8080/homeInManchester/api/feedback</p>
					<h4>2.2 返回格式</h4>
					<p>json</p>
					<h4>2.3 http请求方式</h4>
					<p>POST,GET</p>
					<h4>2.4 参数说明</h4>
					<p>
						(1) 公共参数 。详情可以参考 <a href="index.html#public_args">公共参数说明</a>
					</p>
					<p>(2) 私有参数。无。</p>
					
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">参数名称</th>
								<th width="100">是否必填</th>
								<th width="100">类型</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>phone</td>
								<td>否</td>
								<td>String</td>
								<td>客户预留手机号。</td>
							</tr>
							<tr>
								<td>email</td>
								<td>否</td>
								<td>String</td>
								<td>邮箱。</td>
							</tr>
							<tr>
								<td>content</td>
								<td>是</td>
								<td>String</td>
								<td>反馈内容。</td>
							</tr>
							<tr>
								<td>name</td>
								<td>否</td>
								<td>String</td>
								<td>客户姓名。</td>
							</tr>

						</tbody>
					</table>

					<h4>2.5 请求示例</h4>
					<code>http://115.29.250.136:8080/homeInManchester/api/feedback</code>

					<h4>2.6 返回参数说明</h4>
					<p>请求正确的话，会成功返回{"value":"true"}。不正确的话，会返回错误码，见2.7说明。</p>

					<h4>2.7 错误返回码说明</h4>
					<p>
						公共错误返回码：参考 ： <a href="index.html#public-code">公共返回码说明</a> 。
					</p>
					<p>私有错误返回码：</p>
					<table class="table table-bordered">
						<thead>
							<tr>
								<th width="120">返回码（code）</th>
								<th width="100">返回信息(msg)</th>
								<th>含义说明</th>
							</tr>
						</thead>
						<tbody>
							<tr>
								<td>2000</td>
								<td>会员未登录！</td>
								<td>未登录用户无权限操作。</td>
							</tr>
							<tr>
								<td>1001</td>
								<td>系统异常</td>
								<td>如果参数不正确，或者缺少必选参数则报此错误。</td>
							</tr>
						</tbody>
					</table>

					<h4>2.8 正确返回示例：</h4>
					
					<pre>
{"value":"true"}
					</pre>
					<h4>2.9 错误返回示例</h4>
					<pre>
{
    "msg": "Required int parameter 'toUserId' is not present", 
    "object": null, 
    "code": "1001"
}
					</pre>
					<pre>
					{
    "msg": "会员未登录，不允许发表评论！", 
    "object": null, 
    "code": "2000"
}
					</pre>
					
				</section>
				
			</div>
		</div>

	</div>



	<!-- Footer
    ================================================== -->
	<footer class="footer">
		<div class="container">
			<p>
				Designed and built with all the love in the world by <a
					href="http://www.hcrazy.com" target="_blank">@hsmart</a>
			</p>
			<ul class="footer-links">
				<li><a href="http://www.hcrazy.com">Blog</a></li>
				<li class="muted">&middot;</li>
				<li><a href="http://www.hcrazy.com">Issues</a></li>
				<li class="muted">&middot;</li>
				<li><a href="http://www.hcrazy.com">Changelog</a></li>
			</ul>
		</div>
	</footer>



	<!-- Le javascript
    ================================================== -->
	<!-- Placed at the end of the document so the pages load faster -->
	<script src="assets/js/jquery.js"></script>
	<script src="assets/js/bootstrap-transition.js"></script>
	<script src="assets/js/bootstrap-alert.js"></script>
	<script src="assets/js/bootstrap-modal.js"></script>
	<script src="assets/js/bootstrap-dropdown.js"></script>
	<script src="assets/js/bootstrap-scrollspy.js"></script>
	<script src="assets/js/bootstrap-tab.js"></script>
	<script src="assets/js/bootstrap-tooltip.js"></script>
	<script src="assets/js/bootstrap-popover.js"></script>
	<script src="assets/js/bootstrap-button.js"></script>
	<script src="assets/js/bootstrap-collapse.js"></script>
	<script src="assets/js/bootstrap-carousel.js"></script>
	<script src="assets/js/bootstrap-typeahead.js"></script>
	<script src="assets/js/bootstrap-affix.js"></script>

	<script src="assets/js/holder/holder.js"></script>
	<script src="assets/js/google-code-prettify/prettify.js"></script>

	<script src="assets/js/application.js"></script>



</body>
</html>
